<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>QSculpt: engine/include/BufferObject.h Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">QSculpt
   &#160;<span id="projectnumber">0.0.1a</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
<div class="header">
  <div class="headertitle">
<div class="title">engine/include/BufferObject.h</div>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***************************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> *   Copyright (C) 2008 by Juan Roberto Cabral Flores                      *</span>
<a name="l00003"></a>00003 <span class="comment"> *   roberto.cabral@gmail.com                                              *</span>
<a name="l00004"></a>00004 <span class="comment"> *                                                                         *</span>
<a name="l00005"></a>00005 <span class="comment"> *   This program is free software; you can redistribute it and/or modify  *</span>
<a name="l00006"></a>00006 <span class="comment"> *   it under the terms of the GNU General Public License as published by  *</span>
<a name="l00007"></a>00007 <span class="comment"> *   the Free Software Foundation; either version 2 of the License, or     *</span>
<a name="l00008"></a>00008 <span class="comment"> *   (at your option) any later version.                                   *</span>
<a name="l00009"></a>00009 <span class="comment"> *                                                                         *</span>
<a name="l00010"></a>00010 <span class="comment"> *   This program is distributed in the hope that it will be useful,       *</span>
<a name="l00011"></a>00011 <span class="comment"> *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *</span>
<a name="l00012"></a>00012 <span class="comment"> *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *</span>
<a name="l00013"></a>00013 <span class="comment"> *   GNU General Public License for more details.                          *</span>
<a name="l00014"></a>00014 <span class="comment"> *                                                                         *</span>
<a name="l00015"></a>00015 <span class="comment"> *   You should have received a copy of the GNU General Public License     *</span>
<a name="l00016"></a>00016 <span class="comment"> *   along with this program; if not, write to the                         *</span>
<a name="l00017"></a>00017 <span class="comment"> *   Free Software Foundation, Inc.,                                       *</span>
<a name="l00018"></a>00018 <span class="comment"> *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *</span>
<a name="l00019"></a>00019 <span class="comment"> ***************************************************************************/</span>
<a name="l00020"></a>00020 
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef BUFFEROBJECT_H_</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define BUFFEROBJECT_H_</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;QtOpenGL/QtOpenGL&gt;</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &quot;Point3D.h&quot;</span>
<a name="l00026"></a>00026 
<a name="l00027"></a><a class="code" href="class_buffer_object.html">00027</a> <span class="keyword">class </span><a class="code" href="class_buffer_object.html">BufferObject</a>
<a name="l00028"></a>00028 {
<a name="l00029"></a>00029 <span class="keyword">public</span>:         
<a name="l00033"></a>00033         <span class="keywordtype">bool</span> needUpdate()<span class="keyword"> const </span>{
<a name="l00034"></a>00034                 <span class="keywordflow">return</span> m_needUpdate;
<a name="l00035"></a>00035         };
<a name="l00036"></a>00036         
<a name="l00040"></a>00040         <span class="keywordtype">void</span> setNeedUpdate(<span class="keywordtype">bool</span> val) {
<a name="l00041"></a>00041                 m_needUpdate = val;
<a name="l00042"></a>00042         };
<a name="l00043"></a>00043         
<a name="l00047"></a>00047         GLuint getBufferID()<span class="keyword"> const </span>{
<a name="l00048"></a>00048                 <span class="keywordflow">return</span> m_vboID;
<a name="l00049"></a>00049         };
<a name="l00050"></a>00050         
<a name="l00054"></a>00054         GLenum getType()<span class="keyword"> const </span>{
<a name="l00055"></a>00055                 <span class="keywordflow">return</span> m_boTarget;
<a name="l00056"></a>00056         };
<a name="l00057"></a>00057         
<a name="l00061"></a>00061         <span class="keywordtype">bool</span> mapBuffer(GLvoid** buffer, GLuint* size);
<a name="l00062"></a>00062         
<a name="l00066"></a>00066         <span class="keywordtype">bool</span> unmapBuffer();
<a name="l00067"></a>00067         
<a name="l00071"></a>00071         <span class="keywordtype">int</span> getBufferSize()<span class="keyword"> const </span>{
<a name="l00072"></a>00072                 <span class="keywordflow">return</span> m_bufferSize;
<a name="l00073"></a>00073         }
<a name="l00074"></a>00074         
<a name="l00078"></a>00078         <span class="keywordtype">bool</span> setBufferData(GLvoid* buffer, GLuint size);
<a name="l00079"></a>00079         
<a name="l00083"></a>00083         <span class="keywordtype">bool</span> setBufferSubData(GLint offset, GLuint size, GLvoid* buffer);
<a name="l00084"></a>00084         
<a name="l00085"></a>00085         <span class="comment">//private:</span>
<a name="l00089"></a>00089 <span class="comment"></span>        <span class="keywordtype">bool</span> <a class="code" href="class_buffer_object.html#aad29a14339ce59043e65931fe95e08bd">create</a>();
<a name="l00090"></a>00090         
<a name="l00094"></a>00094         <span class="keywordtype">bool</span> <a class="code" href="class_buffer_object.html#a762ae98559820323e1233d35f89453e8">destroy</a>();
<a name="l00095"></a>00095         
<a name="l00096"></a>00096 <span class="keyword">protected</span>:
<a name="l00100"></a>00100         <a class="code" href="class_buffer_object.html#a2d96f55ee13c92c9bed6355822d1a522">BufferObject</a>(GLenum boTarget = 0);
<a name="l00101"></a>00101         
<a name="l00102"></a>00102         GLenum          m_boTarget;
<a name="l00103"></a>00103         GLuint          m_vboID;                <span class="comment">/*&lt; ID of the vertex buffer object */</span>
<a name="l00104"></a>00104         GLuint          m_bufferSize;   <span class="comment">/*&lt; Size of the buffer in bytes? */</span>
<a name="l00105"></a>00105         <span class="keywordtype">bool</span>            m_needUpdate;   <span class="comment">/*&lt; True if the data needs to be updated*/</span>
<a name="l00106"></a>00106 };
<a name="l00107"></a>00107 
<a name="l00108"></a><a class="code" href="class_buffer_object.html#a2d96f55ee13c92c9bed6355822d1a522">00108</a> <span class="keyword">inline</span> <a class="code" href="class_buffer_object.html#a2d96f55ee13c92c9bed6355822d1a522">BufferObject::BufferObject</a>(GLenum boTarget)
<a name="l00109"></a>00109 :       m_boTarget(boTarget),
<a name="l00110"></a>00110         m_vboID(0),
<a name="l00111"></a>00111         m_bufferSize(0),
<a name="l00112"></a>00112         m_needUpdate(true)
<a name="l00113"></a>00113 {
<a name="l00114"></a>00114 }
<a name="l00115"></a>00115 
<a name="l00119"></a><a class="code" href="class_buffer_object.html#aad29a14339ce59043e65931fe95e08bd">00119</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_buffer_object.html#aad29a14339ce59043e65931fe95e08bd">BufferObject::create</a>()
<a name="l00120"></a>00120 {
<a name="l00121"></a>00121         glGenBuffers(1, &amp;m_vboID);
<a name="l00122"></a>00122         <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00123"></a>00123 }
<a name="l00124"></a>00124 
<a name="l00128"></a><a class="code" href="class_buffer_object.html#a762ae98559820323e1233d35f89453e8">00128</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_buffer_object.html#a762ae98559820323e1233d35f89453e8">BufferObject::destroy</a>()
<a name="l00129"></a>00129 {
<a name="l00130"></a>00130         <span class="keywordtype">bool</span> result = <span class="keyword">false</span>;
<a name="l00131"></a>00131         
<a name="l00132"></a>00132         <span class="keywordflow">if</span> (glIsBuffer(m_vboID))
<a name="l00133"></a>00133         {
<a name="l00134"></a>00134                 glDeleteBuffers(1, &amp;m_vboID);
<a name="l00135"></a>00135         THROW_IF_GLERROR(__func__);
<a name="l00136"></a>00136                 RET_ON_GLERROR(result);
<a name="l00137"></a>00137                 <span class="comment">// Reset value</span>
<a name="l00138"></a>00138                 m_vboID = 0;
<a name="l00139"></a>00139                 m_bufferSize = 0;
<a name="l00140"></a>00140         }
<a name="l00141"></a>00141         result = <span class="keyword">true</span>;
<a name="l00142"></a>00142         <span class="keywordflow">return</span> result;
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144 
<a name="l00145"></a>00145 
<a name="l00149"></a>00149 <span class="keyword">inline</span> <span class="keywordtype">bool</span> BufferObject::mapBuffer(GLvoid** buffer, GLuint* size)
<a name="l00150"></a>00150 {
<a name="l00151"></a>00151         <span class="keywordtype">bool</span> result = <span class="keyword">false</span>;
<a name="l00152"></a>00152         
<a name="l00153"></a>00153         <span class="comment">// Check parameters are not NULL</span>
<a name="l00154"></a>00154         <span class="keywordflow">if</span> (buffer == NULL || size == NULL)
<a name="l00155"></a>00155                 <span class="keywordflow">return</span> result;
<a name="l00156"></a>00156         
<a name="l00157"></a>00157         <span class="comment">// Be sure we are working with our buffer</span>
<a name="l00158"></a>00158         glBindBuffer(m_boTarget, m_vboID);
<a name="l00159"></a>00159     THROW_IF_GLERROR(__func__);
<a name="l00160"></a>00160     RET_ON_GLERROR(result);
<a name="l00161"></a>00161         
<a name="l00162"></a>00162         <span class="comment">// Set the buffer of the mapped object</span>
<a name="l00163"></a>00163         *buffer = glMapBuffer(m_boTarget, GL_READ_WRITE);
<a name="l00164"></a>00164         *size = 0;
<a name="l00165"></a>00165     THROW_IF_GLERROR(__func__);
<a name="l00166"></a>00166     RET_ON_GLERROR(result);
<a name="l00167"></a>00167         
<a name="l00168"></a>00168         <span class="comment">// If the mapping was successful, update the size value</span>
<a name="l00169"></a>00169         <span class="keywordflow">if</span> (*buffer != NULL)
<a name="l00170"></a>00170         {
<a name="l00171"></a>00171                 *size = m_bufferSize;
<a name="l00172"></a>00172         }
<a name="l00173"></a>00173         result = <span class="keyword">true</span>;
<a name="l00174"></a>00174         <span class="keywordflow">return</span> result;
<a name="l00175"></a>00175 }
<a name="l00176"></a>00176 
<a name="l00177"></a>00177 <span class="keyword">inline</span> <span class="keywordtype">bool</span> BufferObject::unmapBuffer()
<a name="l00178"></a>00178 {
<a name="l00179"></a>00179         <span class="keywordtype">bool</span> result = <span class="keyword">false</span>;
<a name="l00180"></a>00180         
<a name="l00181"></a>00181         <span class="comment">// Be sure we are working with our buffer</span>
<a name="l00182"></a>00182         glBindBuffer(m_boTarget, m_vboID);
<a name="l00183"></a>00183     THROW_IF_GLERROR(__func__);
<a name="l00184"></a>00184     RET_ON_GLERROR(result);
<a name="l00185"></a>00185         
<a name="l00186"></a>00186         <span class="comment">// Unmap the buffer object</span>
<a name="l00187"></a>00187         result = glUnmapBuffer(m_boTarget);
<a name="l00188"></a>00188     THROW_IF_GLERROR(__func__);
<a name="l00189"></a>00189     RET_ON_GLERROR(result);
<a name="l00190"></a>00190         
<a name="l00191"></a>00191     result = <span class="keyword">true</span>;
<a name="l00192"></a>00192         <span class="keywordflow">return</span> result;
<a name="l00193"></a>00193 }
<a name="l00194"></a>00194 
<a name="l00198"></a>00198 <span class="keyword">inline</span> <span class="keywordtype">bool</span> BufferObject::setBufferData(GLvoid* buffer, GLuint size)
<a name="l00199"></a>00199 {
<a name="l00200"></a>00200         <span class="keywordtype">bool</span> result = <span class="keyword">false</span>;
<a name="l00201"></a>00201         
<a name="l00202"></a>00202         glBindBuffer(m_boTarget, m_vboID);
<a name="l00203"></a>00203     THROW_IF_GLERROR(__func__);
<a name="l00204"></a>00204     RET_ON_GLERROR(result);
<a name="l00205"></a>00205         
<a name="l00206"></a>00206         m_bufferSize = size;
<a name="l00207"></a>00207         
<a name="l00208"></a>00208         glBufferData(m_boTarget, 
<a name="l00209"></a>00209                                  m_bufferSize,
<a name="l00210"></a>00210                                  buffer,
<a name="l00211"></a>00211                                  GL_DYNAMIC_DRAW);
<a name="l00212"></a>00212     THROW_IF_GLERROR(__func__);
<a name="l00213"></a>00213     RET_ON_GLERROR(result);
<a name="l00214"></a>00214 
<a name="l00215"></a>00215         result = <span class="keyword">true</span>;
<a name="l00216"></a>00216         <span class="keywordflow">return</span> result;
<a name="l00217"></a>00217 }
<a name="l00218"></a>00218 
<a name="l00219"></a>00219 <span class="keyword">inline</span> <span class="keywordtype">bool</span> BufferObject::setBufferSubData(GLint offset, GLuint size, GLvoid* buffer)
<a name="l00220"></a>00220 {
<a name="l00221"></a>00221         <span class="keywordtype">bool</span> result = <span class="keyword">false</span>;
<a name="l00222"></a>00222     
<a name="l00223"></a>00223         glBindBuffer(m_boTarget, m_vboID);
<a name="l00224"></a>00224     THROW_IF_GLERROR(__func__); m_bufferSize = size;
<a name="l00225"></a>00225     RET_ON_GLERROR(result);
<a name="l00226"></a>00226         
<a name="l00227"></a>00227         glBufferSubData(m_boTarget,
<a name="l00228"></a>00228                                         offset,
<a name="l00229"></a>00229                                         m_bufferSize,
<a name="l00230"></a>00230                                         buffer);
<a name="l00231"></a>00231     THROW_IF_GLERROR(__func__);
<a name="l00232"></a>00232     RET_ON_GLERROR(result);
<a name="l00233"></a>00233         
<a name="l00234"></a>00234     result = <span class="keyword">true</span>;
<a name="l00235"></a>00235     <span class="keywordflow">return</span> result;
<a name="l00236"></a>00236 };
<a name="l00237"></a>00237 
<a name="l00238"></a><a class="code" href="class_vertex_buffer.html">00238</a> <span class="keyword">class </span><a class="code" href="class_vertex_buffer.html">VertexBuffer</a> : <span class="keyword">public</span> <a class="code" href="class_buffer_object.html">BufferObject</a>
<a name="l00239"></a>00239 {
<a name="l00240"></a>00240 <span class="keyword">public</span>:
<a name="l00241"></a>00241         <a class="code" href="class_vertex_buffer.html">VertexBuffer</a>() : <a class="code" href="class_buffer_object.html#a2d96f55ee13c92c9bed6355822d1a522">BufferObject</a>(GL_ARRAY_BUFFER) {}
<a name="l00242"></a>00242 };
<a name="l00243"></a>00243 
<a name="l00244"></a><a class="code" href="class_index_buffer.html">00244</a> <span class="keyword">class </span><a class="code" href="class_index_buffer.html">IndexBuffer</a> : <span class="keyword">public</span> <a class="code" href="class_buffer_object.html">BufferObject</a>
<a name="l00245"></a>00245 {
<a name="l00246"></a>00246 <span class="keyword">public</span>:
<a name="l00247"></a>00247         <a class="code" href="class_index_buffer.html">IndexBuffer</a>() : <a class="code" href="class_buffer_object.html#a2d96f55ee13c92c9bed6355822d1a522">BufferObject</a>(GL_ELEMENT_ARRAY_BUFFER) {}
<a name="l00248"></a>00248 };
<a name="l00249"></a>00249 
<a name="l00250"></a>00250 <span class="preprocessor">#endif </span><span class="comment">/*BUFFEROBJECT_H_*/</span>
</pre></div></div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Thu May 31 2012 16:19:51 for QSculpt by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
